功能使用指南

驭码CodeRider 为开发者提供自然语言生成代码、代码补全、代码调优纠错、单元测试生成、代码解释以及智能技术问答等功能。CodeRider 与 GitLab 深度融合,为企业提供软件开发全生命周期(SDLC)的支持,涵盖企业文档库/代码仓智能问答、议题管理、合并请求智能辅助、代码智能评审、流水线管理等功能。

说明:在 IDE 环境中使用 CodeRider,需要先完成 CodeRider 的安装与登录,相关说明请参考:安装和登录指南

1. 代码智能生成/补全

1.1 代码智能实时补全

当您在 IDE 中编写代码时,在开启代码补全功能的情况下,CodeRider 会根据当前代码文件及相关代码文件内容自动为您实时补全代码,此时您可以使用快捷键逐片段或整个模块接纳代码建议,也可以废弃当前代码建议。

当您开启代码补全增强模式时,CodeRider 会根据您当前代码仓库内容为您推荐更符合业务场景和编程风格的代码建议。代码补全模式设置请参考配置指南

image.png

IDE 中代码补全相关操作快捷键默认如下,如您需修改快捷键配置,请参考配置指南:

操作 macOS Windows
接受全部建议 Tab Tab
逐片段接受建议(仅支持 VS Code) + Ctrl +
废弃当前建议 esc Esc

1.2 自然语言生成代码

您可以在 IDE 中使用自然语言描述您的编程需求,CodeRider 将根据需求指令生成代码建议。

在编辑器中生成代码时,CodeRider 将参考当前代码文件、整个项目仓相关代码内容(增强模式下)自动为您生成代码。您可以使用快捷键逐片段或整个模块接纳生成代码,也可以废弃当前代码建议。(快捷键及模式设置参考“代码智能实时补全”。)

在对话框中生成代码时,您可直接输入自然语言需求,CodeRider 将生成对应代码建议。特别地,当您“@代码仓知识库”并输入需求时,CodeRider 将针对指定的代码仓内容结合需求指令生成代码。您可以点击“在光标处插入”直接将生成代码插入到光标停留位置。

image.png

2. 智能辅助编程

说明:CodeRider 提供代码解释、代码注释、代码修改、单元测试、代码优化功能的快捷触发方式,包含:
- 选中代码片段后,在对话界面单击对应功能快捷操作。
- 选中代码片段后,右键选择 CodeRider,并点击对应功能快捷操作。(Visual Studio Code) image.png

2.1 代码解释

CodeRider 自动识别选中代码的编程语言并生成代码解释,帮助您更高效地阅读和理解代码。 image.png

2.2 代码注释

CodeRider 为所选代码片段生成行间注释,提升代码的可读性,帮助您快速阅读代码。 image.png

2.3 代码修改

CodeRider 根据您输入的代码修改指令完成对选中代码的修改,帮助您快速完成代码优化。 image.png

2.4 单元测试

CodeRider 为所选代码片段生成单元测试代码,帮助您准确、高效地测试函数或代码片段。 image.png

2.5 代码优化

CodeRider 为所选代码片段生成改进建议及参考优化代码,以提升代码的可读性、可维护性、安全性等,帮助您生成更优美的代码。 image.png

3. 智能 DevOps 助手

说明:CodeRider 提供智能 DevOps 辅助功能,包含对项目史诗、议题、合并请求、代码片段、漏洞的管理,支持用户在 IDE 中配置 DevOps 助手操作界面,配置方式请参考配置指南。目前,智能DevOps 助手系列功能仅支持 Visual Studio Code 用户使用。 image.png

3.1 处理议题

CodeRider 支持在议题中生成讨论内容概览,快速清晰地给出议题结论,帮助用户高效地阅读议题信息,提升工作效率。生成的议题摘要,您可以双击修改,并一键评论到议题讨论内容中,同步给当前议题的所有用户。 image.png

3.2 处理合并请求

CodeRider 支持在合并请求中生成内容摘要,包含合并请求的概述、变更内容、影响范围、预期结果等。生成的合并请求摘要,您可以双击修改,并一键评论到合并请求内容中,同步给合并请求提交者。 image.png

3.3 文件级代码智能审核

CodeRider 支持在 IDE 中审核提交的合并请求,同时支持在 IDE 中查看合并请求修改前后的对比代码,并可添加评审建议。

CodeRider 支持的合并请求评审方式分为两种:

  1. AI 代码预评审:支持从代码安全、执行效率、代码风格、功能完整性及用户体验方面评审合并请求,您可以双击修改,并一键评论到合并请求内容中,将评审建议同步给合并请求提交者。
  2. 文件级 AI Code Review:支持针对当前合并请求生成逐文件级的代码评审建议,您可以双击修改,并一键将当前文件或 MR 中所有文件的评审建议评论到 MR 内容中,将评审建议同步给合并请求提交者。 image.png

3.4 代码审核 Agent

CodeRider 支持 GitLab 项目基于 Web 端调用 MR 代码审核 Agent。当群组/项目代码仓已配置好审核功能后,您提交合并请求会自动触发代码审核流程。

手动触发方式:在已提交的 MR 审核框输入 @CODERIDER_AGENT /coderider-review 即可启动评审,稍等片刻即可看到评审建议。

评审意见操作:CodeRider 支持您针对评审建议进行修改、评论,或点击“应用建议”再次提交变更代码。 image.png image.png image.png

3.5 管理流水线

CodeRider 支持在 Visual Studio Code 中操作流水线,包括查看流水线状态、管理流水线、下载流水线产物、创建流水线。 image.png

IDE 中唤醒流水线操作的快捷键默认如下,如您需修改快捷键配置,请参考配置指南

操作 macOS Windows
唤醒流水线操作 + + P Shift + Ctrl + P

3.6 查询和处理更多 DevOps 任务

CodeRider支持在 Visual Studio Code 中查看与用户相关的 DevOps 任务,包含查询议题、查看合并请求、查看史诗、查看代码片段、查看漏洞,同时支持自定义搜索构建独有的任务查询。如需配置相关任务类型,请参考参考配置指南image.png

3.7 GitLab 快捷操作命令

CodeRider 支持 20 多种 GitLab 快捷操作命令,包含查看 GitLab 议题和合并请求、创建合并请求、审核合并请求、验证 CI/CD 配置、管理流水线、管理代码片段等。 image.png

IDE 中唤醒 GitLab 快捷操作的快捷键默认如下,如您需修改快捷键配置,请参考配置指南

操作 macOS Windows
唤醒 GitLab 快捷操作 + + P Shift + Ctrl + P

4. 智能问答

说明:IDE 中唤醒智能问答窗口的快捷键默认如下,如您需修改快捷键配置,请参考配置指南

操作 macOS Windows
Visual Studio Code JetBrains IDEs Visual Studio Code JetBrains IDEs
唤醒智能问答窗口 + / + + / Alt + / Ctrl + Alt + /

4.1 自然语言多轮技术问答

当配置模型生效后,您可以灵活选择本地模型、云端模型、私有模型(企业私有化部署用户)来完成研发技术问答,您无需离开编程界面即可使用 CodeRider 解决研发中的技术难题。同时,CodeRider 支持多轮对话问答,能够快速响应开发人员的问题,并提供准确的解决方案。另外,当您需要针对代码片段提问时,请先将对应代码片段粘贴到对话输入框,并输入相关问题。 image.png

4.2 知识库问答

CodeRider 支持基于云端模型、私有模型(私有化部署企业)的企业知识库功能,拥有访客及以上权限的用户可以在对话框“@” 知识库名称,并针对知识库内容进行技术问答。同时,CodeRider 支持您配置自己的知识库,包括创建、更新、设置别名、删除,配置操作请参考配置指南image.png

4.3 企业代码问答

CodeRider 支持基于云端模型、私有模型(私有化部署企业)的企业代码问答功能,拥有访客及以上权限的用户可以在对话框“@” 代码知识库名称,并针对代码知识库内容进行技术问答。同时,CodeRider 支持您配置自己的代码知识库,包括创建、更新、设置别名、删除,配置操作请参考配置指南image.png

4.4 智能研发问答平台

CodeRider 提供企业级问答平台,支持自然语言问答、企业知识库问答、企业代码问答功能。企业非技术用户无需依赖编程 IDE 即可体验 CodeRider 问答功能,助力团队高效管理和利用企业内部文档,提升企业数字资产价值。请登录智能研发问答平台体验问答功能。 image.png